home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _utilities / utilities / 001 / _backgrdii / !BackGrdII / Info < prev    next >
Text File  |  1992-11-29  |  20KB  |  418 lines
  1. ============================================================================
  2. ╗╗╗╗ Documentation for !BackGrd release II version 2.20
  3. ============================================================================
  4.  
  5. IMPORTANT NOTE: COPYRIGHT
  6.  
  7. Version 2.20 of !BackGrd is distributed as SHAREWARE. This means that:
  8.  
  9. - This software may be copied and distributed freely, provided that no
  10.   profit is made from doing so. Passing copies between friends is OK, and so
  11.   is uploading it to a bulletin board as long as it can be downloaded free
  12.   (except for the 'phone charges for the call). It may also be supplied on
  13.   disc by PD libraries, as long as the only charge is for media and P&P.
  14.   This software must always be supplied complete and unaltered. Copyright
  15.   remains with the author at all times.
  16.  
  17. - After you receive a copy, you may use it for a TWO WEEK TRIAL PERIOD.
  18.   After this period, if you want to continue using this software, YOU MUST
  19.   REGISTER YOUR COPY with the author, and pay a small registration fee of
  20.   ú5 which ensures you of full support. To register your copy, send the
  21.   registration fee to the address given at the end of this file. Cheques
  22.   & POs should be made payable to 'Andrew Cawte'.
  23.  
  24. - If you decide after the trial period that you do not wish to register your
  25.   copy, YOU MUST DESTROY IT IMMEDIATELY. FAILURE TO DESTROY YOUR COPY AFTER
  26.   THE TWO-WEEK TRIAL PERIOD IS A BREACH OF COPYRIGHT.
  27.  
  28. - I accept no responsibility whatsoever for any loss or damage caused by the
  29.   use or misuse of this program. Support for this program includes the
  30.   !BackGrdII application and 'Convert' and 'Reset' utilities only. That
  31.   means that if, for example, saving a state file destroys your hard disc,
  32.   it's your problem and not mine.
  33.  
  34. ============================================================================
  35.  
  36. What is !BackGrd?
  37. -----------------
  38.  
  39. !BackGrd allows you to drag files out of Filer windows and 'stick' them to
  40. the backdrop. When a file (or directory or application) has been stuck to
  41. the backdrop, you can:
  42.  
  43. 1) Run it by double-clicking in the usual way;
  44. 2) Drag it aroung the backdrop;
  45. 3) Assign it a keyboard short-cut, which will run it as if it had been
  46.    double-clicked.
  47.  
  48. In addition, you can replace the dull grey desktop background with any
  49. suitable sprite. In modes with 96 or more text columns and 16 or more
  50. colours, !BackGrd can display various useful pieces of information about
  51. the system in a status bar, which rests above the icon bar.
  52.  
  53. You can also create your own icons on the backdrop which will execute any
  54. OS '*' command when double-clicked. These can be dragged around and assigned
  55. keyboard short-cuts just like files and applications.
  56.  
  57. Having placed a number of files, and possibly a picture, on the backdrop,
  58. you can then save the positions of all the icons to disc, so that you don't
  59. have to reconfigure !BackGrd every time you load it. Different state files
  60. may be kept for different purposes, and any one of these may be made the
  61. default - this one is loaded automatically whenever !BackGrd is run.
  62.  
  63.  
  64. Getting started
  65. ===============
  66.  
  67. Load !BackGrd by double-clicking on its icon in a Filer window, in the same
  68. way as any other application. When loaded, it will place an icon on the icon
  69. bar.
  70.  
  71. Initially, you will want to place some files on the backdrop. To do this,
  72. drag a file out of a directory viewer onto the grey desktop background.
  73. After a short pause, the file will appear on the backdrop - you can drag up
  74. to 40 different files to the backdrop in this way. These may be dragged
  75. around the backdrop using the <SELECT> mouse button, and run by
  76. double-clicking.  If you hold down <CTRL> while dragging icons around the
  77. backdrop, they will 'snap' to an invisible grid, thus ensuring that they all
  78. line up nicely.
  79.  
  80. If you want to drag a number of icons together, you may select them each
  81. individually using <ADJUST>, or you may drag a box round them with <SELECT>,
  82. in a similar way to selecting objects in !Draw.
  83.  
  84. Whilst a file is being loaded by !BackGrd, the icon on the icon bar will
  85. change from an Archimedes 'A' to an hourglass, to indicate that the
  86. double-click or hot-key was indeed recognised. This is particularly handy
  87. if you have a defective rodent with dodgy buttons.
  88.  
  89. To replace the desktop grey with a sprite, drag the sprite file to the
  90. !BackGrd icon on the icon bar. The file will be loaded, and will appear on
  91. the background. If the sprite looks strange, you're probably trying to
  92. display a 256 colour sprite in a 16 colour screen mode - try changing into
  93. mode 15. If the file contains more than one sprite, only the first one will
  94. be displayed (although the others will use up memory).
  95.  
  96.  
  97. The !BackGrd menus
  98. ==================
  99.  
  100. Clicking Menu over the backdrop brings up !BackGrd's main menu. This
  101. allows you control over the icons on the backdrop, to set up keyboard short
  102. cuts, to save the status of the backdrop to a file, and to quit the
  103. application.
  104.  
  105. The options in detail
  106. ---------------------
  107.  
  108. 1) Info
  109.  
  110. Moving the pointer to the right over this option brings up a window
  111. containing information about the current version of the program.
  112.  
  113. 2) Options
  114.  
  115. If no icons are selected, this option will be greyed out, otherwise the word
  116. 'options' will be replaced by the name of the selected icon, or 'Selection'
  117. if more than one icon is selected (similar to the Filer's menu - if you
  118. click <MENU> when no icons are selected, the icon you clicked over will be
  119. selected). This option leads to a submenu with several further options,
  120. which allow you a good degree of control over the selected icon(s)
  121.  
  122. Moving right over 'define hotkey' leads to a dialogue box containing the
  123. program name, a small writable icon, and an OK icon. To set up a keyboard
  124. short cut for a program, type a letter A-Z and click on OK or press
  125. <RETURN>. From now on, pressing <CTRL> together with that letter will run
  126. that program. To change the short-cut to a program, bring up the dialogue
  127. box again, replace the letter offered with the new one, and click OK. To
  128. remove the short-cut from a program, bring up the dialogue box, delete the
  129. letter and click OK.
  130.  
  131. The option 'Remove' removes the selected icons icon from the backdrop, and
  132. removes any hot keys associated with those icons.
  133.  
  134. 'Run boot', available only for applications, allows you to specify that the
  135. !Boot file inside the application directory should be run before the
  136. application itself is run. Normally, the !Boot file is run whenever the
  137. application is 'seen' by the Filer for the first time. This !Boot file
  138. usually loads in some sprites, tells RISC OS to load that application
  139. whenever one of its files is double-clicked and so on. Typical
  140. symptoms of a program needing its !Boot file executed are installing an
  141. invisible icon on the icon bar, not recognising files that it should load,
  142. having the wrong file icons and so on. To solve this problem, turn 'Run
  143. boot' on (a tick appears next to the option). This will cause the !Boot file
  144. to be executed as well whenever the application is run from !BackGrd
  145. (whether by double-clicking or a keyboard short-cut).
  146.  
  147. Note that most applications are well behaved and do not require their !Boot
  148. files - hence this option is normally off. If an application misbehaves when
  149. run from !BackGrd, turn this option on and the problem should go away.
  150. (Note that under Release I of !BackGrd, programs which were stuck to the
  151. backdrop occasionally wouldn't run from anything but the backdrop. This
  152. should no longer happen).
  153.  
  154. Some applications do not have !Boot files at all, but still require to have
  155. their sprite files loaded - !MultiFS (as supplied with the new PC Emulator)
  156. is such an application. If you have such a 'problem' application, turn on
  157. 'Load sprites' for that application. Applications which do have !Boot files
  158. should not require 'Load sprites' as well, but it does no harm to try.
  159.  
  160. (Note that under Release I of !BackGrd, the main application sprite for
  161. every application on the backdrop was copied into the Wimp sprite area when
  162. the backdrop was loaded. To save memory, Release II no longer does this.
  163. However, this does mean that some applications may need 'Load Sprites' on
  164. under Release II that didn't under Release I. This is only really noticeable
  165. if you are using a state file converted from Release I - if an application
  166. starts giving trouble then turn on 'Run boot' or 'Load sprites' and it
  167. should be OK).
  168.  
  169. 'Open parent dir' opens the directory viewer for the program. This is
  170. useful if, for example, you wanted to copy a program that was stuck to the
  171. backdrop, or wanted to find out exactly where in your hard disc's directory
  172. structure it resided. It is also useful if you want to find out what disc
  173. something is on, or what is on the same disc.
  174.  
  175. 'Edit', available only for '*' command icons (and not files or applications)
  176. enables you to change the text which appears below the icon, and the command
  177. which the icon executes when double-clicked. See the description of command
  178. icons below.
  179.  
  180. 3) Select all
  181.  
  182. This selects all the icons on the backdrop, so that subsequent operations
  183. such as dragging or removing them will affect them all. It is equivalent to
  184. dragging a selection box round all the icons on the screen.
  185.  
  186. 4) Clear selection
  187.  
  188. This deselects all the icons on the backdrop.
  189.  
  190. 5) Display
  191.  
  192. This leads to a submenu which offers a degree of control over how the icons
  193. on the backdrop appear.
  194.  
  195. The first two, 'Text colour' and 'Background colour' both lead to colour
  196. menus, allowing you to choose the foreground and background colours for the
  197. text (filenames) on the backdrop. The default values of white on grey look
  198. good on the standard backdrop, but you may want to change them if you are
  199. using a sprite as a background instead.
  200.  
  201. 'Application names' allows you to choose whether applications appear as
  202. their icon plus their filename (as in Filer windows) or just as the icon.
  203. This is entirely a matter of personal preference and does not affect how
  204. they work at all. I personally prefer just the icon, because they take up
  205. less room on the screen and I can see more of the sprite background - hence
  206. this option is off by default.
  207.  
  208. 'Icon on icon bar' lets you choose whether or not to have the !BackGrd icon
  209. stationed on the icon bar. Removing the icon means that you won't be able to
  210. see the hourglass indicator, and prevents you from loading in new sprites to
  211. display in the background, so if you want to load a new one you have to
  212. switch the icon on, drag the sprite file to it, then switch it off again.
  213. However, this doesn't apply to state files, which can also be loaded by
  214. double-clicking.
  215.  
  216. 'Change to sprite mode' allows you to choose whether or not to have the
  217. Desktop screen mode automatically change to the correct one whenever a
  218. sprite is loaded for use as a backdrop. For example, you may keep your
  219. machine configured 'WimpMode 12', so the Desktop comes on in Mode 12 by
  220. default. If you then load a Mode 15 sprite with this option off, you
  221. will see garbage on the screen until you change to a 256 colour mode
  222. manually. With this option on, however, Mode 15 will be selected for you
  223. automatically when you load the sprite.
  224.  
  225. 'Status Bar' turns on a bar which sits just above the icon bar, and shows
  226. several useful pieces of information about the system, namely:
  227.  
  228. Amount of free RAM
  229. Size of font cache, and amount actually used
  230. Free space in the RMA
  231. Screen mode
  232. The current time
  233.  
  234. The status bar is only available in modes with 96 or more characters per
  235. line and 16 or more colours. Users with 'standard' (type 0) monitors might
  236. consider using an overscan mode, which is included in RISC OS 3 as standard
  237. (modes 35 and 36), or can be created using any one of a number of PD
  238. utilities available. I use a mode which is 96 columns by 35 rows; mode 35
  239. (which is one 96x36) loses a couple of pixels from the top row on my monitor.
  240. The extra work area is surprisingly useful.
  241.  
  242. 6) Short cuts
  243.  
  244. This leads to a table showing all the possible keyboard short-cuts (A-Z) and
  245. the programs they are currently assigned to. An icon at the bottom of this
  246. window allows you to select whether hot keys are recognised or not. You
  247. might want to disable them temporarily if you are using the keyboard a lot
  248. (eg. word processing), just in case you accidentally start loading
  249. applications!
  250.  
  251. 7) Kill picture
  252.  
  253. Selecting this option removes the background picture and frees the memory
  254. which was used by it. This option is greyed out if no sprite is loaded.
  255.  
  256. 8) New command
  257.  
  258. This option leads to a dialogue box which allows you to create an icon on
  259. the backdrop, which will execute a '*' command when double-clicked. The
  260. box contains two writable icons and an 'OK' box.
  261. The top (smaller) icon allows you to type in what you want to appear below
  262. the '*' command sprite. This is so that if you have several commands on
  263. the backdrop, you can easily tell them apart. As with filenames, you may
  264. have up to ten characters for this identifier.
  265. The bottom (larger) icon is where you type the command itself. Press
  266. <RETURN> or click on OK when you've finished.
  267.  
  268. IMPORTANT: Don't forget that when the command is executed, !BackGrd is
  269. still active, so don't use any command that could cause it to crash. For
  270. example, don't *LOAD a file into application space or try to enter BASIC.
  271. If you want the icon to run a program, drag that program to the backdrop
  272. and don't use a command icon at all.
  273.  
  274. 9) State
  275.  
  276. This leads to a submenu allowing you to save the state of the backdrop, or
  277. make the current state the default one.
  278.  
  279. The first option on this menu, 'Save', leads to a standard save dialogue
  280. box. To save the file, drag it to a Filer window or type in a filename and
  281. click OK. All the settings in !BackGrd will be saved, including the
  282. positions of all the icons, colours, flags etc.
  283.  
  284. Note that the sprite being used as a background is NOT saved (only its
  285. pathname), in order to conserve disc space. This means that when the state
  286. is re-loaded, !BackGrd will attempt to load the sprite back in from wherever
  287. it was initially loaded from. You may therefore be prompted to insert a
  288. disc containing the sprite if it was originally loaded from a different disc
  289. to the one containing the state file. This obviously doesn't apply to hard
  290. discs, where the sprite and state file will almost invariably be loaded from
  291. the same disc.
  292.  
  293. Under RISC OS 3, it is possible to configure the machine so that rather than
  294. dragging an outline to save a file, a solid icon is dragged. To configure
  295. solid icons, press F12 and type *FX162 28 3. To configure outlines again,
  296. type *FX162 28 1. (Not all applications support dragging solid icons - all
  297. the applications supplied with RISC OS 3.10 do, as do many of those supplied
  298. with RISC OS 3.00. !BackGrdII is one of a very few third party applications
  299. to support this feature).
  300.  
  301. The second option on the menu, 'Make default', makes the current state file
  302. (ie. the last one which was loaded or saved) the default one, which is
  303. loaded whenever !BackGrd is loaded. If the backdrop has been altered since
  304. it was last saved, you will need to save it to a file first.
  305.  
  306. 10) Quit
  307.  
  308. This removes the !BackGrd application from memory.
  309.  
  310.  
  311. Clicking Menu over the icon bar icon brings up a menu containing a subset of
  312. these options - Info, State and Quit.
  313.  
  314. Since version 2.10, it is impossible to have more than one copy of
  315. !BackGrdII resident in the machine at once. This is to save memory (in case
  316. an attempt is made to accidentally install a second copy) and to avoid
  317. conflict between several different copies of the program all resident at
  318. once. The rules governing how copies are installed are as follows:
  319.  
  320. - The first copy will install as usual.
  321. - If an attempt is made to install a second copy, the first copy will load
  322.   the second copy's default state file.
  323. - If a copy of !BackGrdII itself is dragged to the !BackGrdII icon on the
  324.   icon bar, then that copy's default state file will be loaded.
  325.  
  326.  
  327. Upgrading from versions prior to 2.00
  328. =====================================
  329.  
  330. Release II uses a different format for its state-save files from earlier
  331. versions. This is to save disc space (the new format is more compact), and
  332. to allow more options to be stored in the file (to allow for more future
  333. expansion).
  334.  
  335. A utility is provided to convert files saved by Release I to files
  336. compatible with Release II. It is called 'Convert' and may be found inside
  337. the !BackGrdII application directory. Run it by double-clicking, or from the
  338. command line.
  339.  
  340. You will be asked for a source filename and an output filename. Type the
  341. full pathnames of the original (Release I, type &455) state-save file and
  342. the new (Release II, type &44F) file to create. These two MUST be different
  343. - otherwise you'll just corrupt the file you're trying to convert.
  344.  
  345. Once both pathnames have been entered, the new file will be created. Once
  346. you have tested the new state file and ensured that it performs correctly
  347. (there may be very minor differences between the new state under Release II
  348. and the old state in Release I), you can delete the old file.
  349.  
  350.  
  351. Bugs?!
  352. ======
  353.  
  354. It is an unfortunate fact of life that just about every computer program has
  355. bugs in it. I don't know of any bugs in this version of !BackGrd, but that's
  356. not to say that they can't exist, and I would greatly appreciate reports of
  357. suspected bugs in this program (not that I can guarantee that I'll be able
  358. to fix them all!)
  359.  
  360. If you have a bug to report, then please write or 'phone with as much
  361. information as you have about it. For example:
  362.  
  363. All about the state file you're using (flags, how many icons, what backdrop
  364. sprite and so on). If you have a particular state file that causes trouble,
  365. it would help a lot if you enclose a disc with a copy of it on.
  366.  
  367. The exact specification of your machine. This program is intended primarily
  368. for use with RISC OS 2; Arthur simply can't cope (and if your machine STILL
  369. uses it then you'll get no sympathy from me!). It is, however, compatible
  370. with RISC OS 3, and you may well wish to use it in preference to Pinboard
  371. because of its extra features. I may in the future release a program to
  372. upgrade Pinboard to the full specification of !BackGrdII.
  373.  
  374. Where your copy of !BackGrdII came from. This may sound irrelevant, but it's
  375. a fact that software which has been exposed to many users (eg. has been
  376. installed on a network) tends to get mucked about. The only copies which I
  377. can guarantee work correctly are ones which I send out, but copies
  378. distributed by reputable PD libraries should also be OK. If you find a
  379. glaringly obvious bug which I couldn't possible have missed (like crashing
  380. with 'Address Exception' whenever you try to load the program), you probably
  381. have a corrupted copy. Try resetting it as described below.
  382.  
  383.  
  384. Resetting !BackGrd
  385. ==================
  386.  
  387. If your copy of !BackGrdII is already configured for a system other than
  388. your own, you may want to reset it to its default configuration (no icons,
  389. no backdrop sprite and sensible defaults for the flags). A program has been
  390. provided to do just that - it's called 'Reset', and can be found inside the
  391. !BackGrdII application directory.
  392.  
  393. When run (by double-clicking or from the command line), it will prompt for
  394. confirmation - press Y or click the left mouse button to continue.
  395. !BackGrdII will then be reset to its default configuration, from which it
  396. should load with no trouble.
  397.  
  398.  
  399. Contacting the author
  400. =====================
  401.  
  402. If you want to get in touch with the author (to register your copy, for
  403. example), then write to the following address:
  404.  
  405. Andrew Cawte
  406. 64 Blenheim Gardens
  407. Denvilles
  408. Havant
  409. Hants.
  410. PO9 2PW
  411.  
  412. or 'phone on (0705) 451886 after 6pm.
  413.  
  414. If you have trouble with your copy of !BackGrdII, then please try to obtain
  415. a fresh copy from a PD library before contacting me. I write software, not
  416. distribute it. Full support, however, is provided to registered users.
  417. Full information about licensing and registration is provided at the
  418. beginning of this text file.